/*
 * Copyright 2004 original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jbfilter.core.fcomps.single;

import org.jbfilter.core.JbfilterComparatorKeyword;
import org.jbfilter.core.NullTestingEnableable;
import org.jbfilter.core.PropertyAccessible;

/**
 * The base for filter components where filter behavior is determined by a comparison operator.
 * @author Marcus Adrian
 *
 * @param <E> the beans' type
 * @param <T> the property's type
 */
public interface CompareFilterComponent<E, T>
	extends
		SingleFilterComponent<E, T>,
		NullTestingEnableable,
		PropertyAccessible {
	
	void setComparatorKeyword(JbfilterComparatorKeyword comparatorKeyword);
	JbfilterComparatorKeyword getComparatorKeyword();
	/**
	 * For dynamic filter components, that is where the {@code comparatorKeyword} might change,
	 * this will be the {@code comparatorKeyword} value the {@link #clean()} call.
	 * @param comparatorKeywordCleanValue
	 */
	void setComparatorKeywordCleanValue(JbfilterComparatorKeyword comparatorKeywordCleanValue);
	/**
	 * The {@code comparatorKeyword} after a {@link #clean()} call.
	 * @return
	 */
	JbfilterComparatorKeyword getComparatorKeywordCleanValue();
}
